<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="MP3,org.outertia.audio.MP3,addDirectory,addFile,addComment" name="keywords">
<title>org.outertia.audio.MP3Header</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'MP3Header - MP3Tools API Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">MP3Tools API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?org/outertia/audio/MP3Header.html&amp;org/outertia/audio/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class MP3Header</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class MP3Header"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.outertia.audio</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MP3Header</td>
</tr>
</table>
<p></p>
 The class represents a header of a MP3 frame.<p></p>
<br>
<hr>
</div>

<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#channels">channels</a> : uint = 0<div class="summaryTableDescription">Number of audio channels used.</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#crc">crc</a> : uint = 0<div class="summaryTableDescription">The CRC16 value of the frame belonging to this header.</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#freq">freq</a> : int = 0<div class="summaryTableDescription">Index in MP3Header.FREQ of the value of the frequency of the MP3 frame belonging to the header. [0] = 44100hz - the frequency used by Flash</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#padded">padded</a> : int = 0<div class="summaryTableDescription">Padding of the mp3 frame belonging to the header.</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#rate">rate</a> : uint = 192<div class="summaryTableDescription">Bit-rate of the mp3 frame belonging to the header - otherwise known as the quality.</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#version">version</a> : uint = 1<div class="summaryTableDescription">Version of the MPEG encoding scheme of the mp3 frame belonging to the header. Keep as 1 unless you know what you are doing.</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FREQ">FREQ</a> : Array(4) <div class="summaryTableDescription">[static][const] Valid frequencies of MP3 frames.</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#L3V1">L3V1</a> : Array(16) <div class="summaryTableDescription">[static][const] Valid bit rates of a MP3 version 1 frame</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#L3V2">L3V2</a> : Array(16) <div class="summaryTableDescription">[static][const] Valid bit rates of a MP3 version 2 frame</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#L3Vrate">L3Vrate</a> : Array(4) <div class="summaryTableDescription">[static][const] Valid bit rates of a MP3 frames, all verions</div>
</td><td class="summaryTableOwnerCol">MP3Frame</td>
</tr>
</table>
<a name="methodSummary"></a>
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#MP3Header()">MP3Header</a>( rate:uint = 192, channels:uint = 2, version:uint = 1, freq:uint = 0, crc:uint = 0, padded:uint = 0 )</div>
<div class="summaryTableDescription"> Creates the MP3Header.</div>
</td><td class="summaryTableOwnerCol">MP3</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>

<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>

<a name="FREQ"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FREQ</td><td class="detailHeaderType">static property</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FREQ:Array(4)</code><p> Valid frequencies. [0]:44100 recommended. VALUES: [44100,48000,32000,0]</p>
</div>

<a name="L3V1"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">L3V1</td><td class="detailHeaderType">static property</td>
</tr>
</table>
<div class="detailBody">
<code>public static const L3V1:Array(16)</code><p> Valid bit rates for "normal" mp3s. VALUES: [0,32,40,48,56,64,80,96,112,128, 160,192,224,256,320,0]</p>
</div>

<a name="L3V2"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">L3V2</td><td class="detailHeaderType">static property</td>
</tr>
</table>
<div class="detailBody">
<code>public static const L3V2:Array(16)</code><p> Valid bit rates for mp3 version 2. VALUES: [0,8,16,24,32,40,48,56,64,80, 96,112,128,144,160,0]</p>
</div>

<a name="L3Vrate"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">L3Vrate</td><td class="detailHeaderType">static property</td>
</tr>
</table>
<div class="detailBody">
<code>public static const L3Vrate:Array(4)</code><p> Valid bit rates for all versions. VALUES: [L3V2,L3V1,L3V2,L3V1] </p>
</div>

<a name="channels"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">channels</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public get var channels:int = 0</code><p> Channles of audio in the MP3 frame. 1=Mono, 2=Stereo, 3=Joint</p>
</div>

<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="MP3Frame()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">MP3Frame</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function MP3Header( rate:uint = 192, channels:uint = 2, version:uint = 1, freq:uint = 0, crc:uint = 0, padded:uint = 0 )</code><p>Creates the MP3Header</p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">rate</span>:uint</code> (default = <code>192</code>)<code></code> &mdash; bit rate of the frame
  </td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">channels</span>:uint</code> (default = <code>2</code>)<code></code> &mdash; channels of audio in the frame.
  </td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">version</span>:uint</code> (default = <code>1</code>)<code></code> &mdash; MPEG encoding version.
  </td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">freq</span>:uint</code> (default = <code>0</code>)<code></code> &mdash; index in MP3Header.FREQ of the value of the frequency of the frame.
  </td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">crc</span>:uint</code> (default = <code>0</code>)<code></code> &mdash; CRC16 of the frame data.
  </td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">padded</span>:uint</code> (default = <code>0</code>)<code></code> &mdash; is the frame padded or not.
  </td>
</tr>
</table>
<br>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">Jordan Williams - http://www.quixological.com</center>
</div>
</body>
</html>
<!--Jordan Williams - http://www.quixological.com/mp3tools-->
